<?
/**
 * This file is part of XNAT light.
 *
 * XNAT light is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * XNAT light is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with XNAT light.  If not, see <http://www.gnu.org/licenses/>.
 */
namespace NRG\Exceptions;

use NRG\Framework\Exceptions\BaseException as BaseException;

/**
 * Realm exception
 *
 * @package NRG\Exceptions
 */
class RealmException extends BaseException
{
    /**
     * No such realm
     *
     * @var int
     */
    const NO_SUCH_REALM = 1;

    /**
     * Exception type
     *
     * @var const
     */
    protected $_type;

    /**
     * Realm name
     *
     * @var string
     */
    protected $_realm;

    /**
     * Constructor
     *
     * @param $type const
     * @param $realm string
     */
    public function __construct($type, $realm)
    {
	$this->_type = $type;
	$this->_realm = $realm;
    }

    /**
     * Get exception type
     *
     * @return const
     */
    public function getType()
    {
	return $this->_type;
    }

    /**
     * Get realm name
     *
     * @return string
     */
    public function getRealm()
    {
	return $this->_realm;
    }

    /**
     * Get exception message
     *
     * @return string
     */
    public function getMessage()
    {
	switch($this->_type)
	{
	    case NO_SUCH_REALM:
		$message = "no such realm $realm";
		break;
	    default:
		$message = "unknown realm exception";
		break;
	}

	return $message;
    }
}
